Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2 packages from smimram/ocaml-dblp at 0.1.0 #26631

Closed
wants to merge 1 commit into from

Conversation

smimram
Copy link
Contributor

@smimram smimram commented Sep 27, 2024

This pull-request concerns:

  • dblp.0.1.0: Commandline program do query the DBLP bibliographic database
  • dblp-api.0.1.0: Library to query the DBLP bibliographic database


🐫 Pull-request generated by opam-publish v2.4.0

@avsm
Copy link
Member

avsm commented Sep 28, 2024

Some test failures here; are they serious @smimram?

@smimram
Copy link
Contributor Author

smimram commented Sep 30, 2024

No, they are not serious at all. They are due to

  • a missing dependency on dblp for the runtest alias (thus the failure for dblp-api tests)
  • the absence of network available on the test machines

I have a CI which is working well on github.

I can fix the first if you insist on it (it is already done on the git and will be in future versions), but for the second I am afraid I cannot do much more for now...

@shonfeder
Copy link
Contributor

In https://opam.ci.ocaml.org/github/ocaml/opam-repository/commit/4f459584657e9303ae0d4a88c445a3775830c157/variant/compilers,4.09,dblp.0.1.0

I've noticed

[ERROR] The compilation of dblp.0.1.0 failed at "dune build -p dblp -j 39 @install".

#=== ERROR while compiling dblp.0.1.0 =========================================#
# context              2.3.0~alpha~dev | linux/x86_64 | ocaml-base-compiler.4.09.1 | pinned(https://github.com/smimram/ocaml-dblp/archive/refs/tags/v0.1.0.tar.gz)
# path                 ~/.opam/4.09/.opam-switch/build/dblp.0.1.0
# command              ~/.opam/opam-init/hooks/sandbox.sh build dune build -p dblp -j 39 @install
# exit-code            1
# env-file             ~/.opam/log/dblp-7-afff3b.env
# output-file          ~/.opam/log/dblp-7-afff3b.out
### output ###
<snip>
# File "src/dblp.ml", line 69, characters 4-26:
# 69 |     Filename.quote_command "x-www-browser" ["http://doi.org/" ^ doi] |> Sys.command |> ignore
#          ^^^^^^^^^^^^^^^^^^^^^^
# Error: Unbound value Filename.quote_command

It appear this is because Filename.quote_command was not added until 4.10.

To fix this, we can either write a replacement for for this function, or increase the lower bound on ocaml. WDYT?

Copy link
Contributor

@shonfeder shonfeder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello! This looks like a very useful package. Thank you for taking the time to publish it!

There are several linting fixes to be made to the package data, which I've noted in my review. (The PR has inspired ocurrent/opam-repo-ci#370, which will be a useful addition :) ).

I would be in favor of getting the tests fixed here before we merge it. While we can make exceptions, every exception we make contributes to making the CI results less accurate, undercutting the value proposition in our promising (and IMO, already quite successful) experiment in ecosystem-wide CI/CD.

There are two main benefits:

  • Benefit for users of a package: Users can have good confidence that it will work as expected on tested platforms (of which there are many).
  • Benefit for authors of a package: When the package tests are reliable, we are able to give reliable results in our reverse dependency tests. This means, if any of your dependencies introduce changes that break your package, we will ensure that unintended breakage is fixed or that intended breakage is guarded by adding an upper bound to the opam file.

With this in mind, I would propose that we address

the absence of network available on the test machines

following the example of #25527 (comment), where tests that require network access are moved into a distinct dune target https://github.com/savonet/ocaml-ffmpeg/blob/f97819265c35375b79232443665fbc413fda45f2/test/dune#L6. Conversely, I think you could change the build instructions to use a different target for with-test, but I think that would go against the grain of the dune packaging flow.

If you are open to one of these fixes, but don't have the bandwidth to put it in place, I'd be happy to lend a hand.

maintainer: ["Samuel Mimram"]
authors: ["Samuel Mimram"]
license: "LGPL-3.0-or-later"
homepage: "https://github.com/smimram/ocalm-dblp"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
homepage: "https://github.com/smimram/ocalm-dblp"
homepage: "https://github.com/smimram/ocaml-dblp"

synopsis: "Library to query the DBLP bibliographic database"
description:
"The library provides helper functions to query the DBLP bibliographic database (authors, publications, and venue)."
maintainer: ["Samuel Mimram"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please provide an email for contact. Judging from other packages you have published, this could be

Suggested change
maintainer: ["Samuel Mimram"]
maintainer: ["Samuel Mimram <[email protected]>"]

license: "LGPL-3.0-or-later"
homepage: "https://github.com/smimram/ocalm-dblp"
doc: "https://smimram.github.io/ocaml-dblp/"
bug-reports: "https://github.com/smimram/ocalm-dblp/issues"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
bug-reports: "https://github.com/smimram/ocalm-dblp/issues"
bug-reports: "https://github.com/smimram/ocaml-dblp/issues"

"@doc" {with-doc}
]
]
dev-repo: "git+https://github.com/smimram/ocalm-dblp.git"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
dev-repo: "git+https://github.com/smimram/ocalm-dblp.git"
dev-repo: "git+https://github.com/smimram/ocaml-dblp.git"

maintainer: ["Samuel Mimram"]
authors: ["Samuel Mimram"]
license: "LGPL-3.0-or-later"
homepage: "https://github.com/smimram/ocalm-dblp"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These URIs will also need updating.

synopsis: "Commandline program do query the DBLP bibliographic database"
description:
"Program to query the DBLP bibliographic database and find authors, publications, and venues. It is particularily useful in order to retrieve bibtex entries."
maintainer: ["Samuel Mimram"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same email update here, please.

smimram added a commit to smimram/ocaml-dblp that referenced this pull request Oct 3, 2024
@smimram
Copy link
Contributor Author

smimram commented Oct 3, 2024

Thanks @shonfeder for your clear and detailed review. I will address the points you mentioned and update the PR soon.

@smimram
Copy link
Contributor Author

smimram commented Oct 3, 2024

I had to make a new release and therefore I made a new PR (#26658) which hopefully fixes the above problems.

@shonfeder
Copy link
Contributor

Closing in favor of #26658

@shonfeder shonfeder closed this Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants